man/ostree-init: Briefly describe various modes

Closes: #1561
Closes: #1560
Approved by: cgwalters

diff --git a/man/ostree-init.xml b/man/ostree-init.xml
index b74648db0ed72dc0acf2796f718669293970148b..b272632111f4a22d9b3f282124ff9459dc48f772 100644 (file)
--- a/man/ostree-init.xml
+++ b/man/ostree-init.xml
@@ -69,13 +69,24 @@ Boston, MA 02111-1307, USA.
         <variablelist>
             <varlistentry>
                 <term><option>--mode</option>="MODE"</term>
-                <listitem><para> Initialize repository in given mode
-                (<literal>bare</literal>, <literal>bare-user</literal>,
-                <literal>archive</literal>). The default is
-                <literal>bare</literal>. Note that for
-                <literal>archive</literal> the repository configuration file
-                will actually have <literal>archive-z2</literal>, as that's the
-                historical name.</para></listitem>
+                <listitem><para>
+                    Initialize repository in given mode
+                    (<literal>bare</literal>, <literal>bare-user</literal>,
+                    <literal>bare-user-only</literal>, <literal>archive</literal>).
+                    The default is <literal>bare</literal>. Note that for
+                    <literal>archive</literal> the repository configuration file
+                    will actually have <literal>archive-z2</literal>, as that's
+                    the historical name.</para>
+
+                    <para>See the manual for differences between these modes.
+                    Briefly, <literal>bare</literal> mode stores files as they
+                    are, so they can be directly hardlinked,
+                    <literal>bare-user</literal> uses extended attributes to
+                    store ownership and xattr information, allowing non-root
+                    operations, <literal>bare-user-only</literal> does not store
+                    ownership information, and <literal>archive</literal> stores
+                    files compressed, to be served over the network.
+                </para></listitem>
             </varlistentry>
 
             <varlistentry>

diff --git a/src/ostree/ot-builtin-init.c b/src/ostree/ot-builtin-init.c
index ae0d0cc645a4f4966af284aac53586787f4bf7b4..a4fb5c51304da67401ed92228c55d5a6b70d339d 100644 (file)
--- a/src/ostree/ot-builtin-init.c
+++ b/src/ostree/ot-builtin-init.c
@@ -38,7 +38,7 @@ static char *opt_collection_id = NULL;
  */
 
 static GOptionEntry options[] = {
-  { "mode", 0, 0, G_OPTION_ARG_STRING, &opt_mode, "Initialize repository in given mode (bare, archive)", NULL },
+  { "mode", 0, 0, G_OPTION_ARG_STRING, &opt_mode, "Initialize repository in given mode (bare, bare-user, bare-user-only, archive)", NULL },
 #ifdef OSTREE_ENABLE_EXPERIMENTAL_API
   { "collection-id", 0, 0, G_OPTION_ARG_STRING, &opt_collection_id,
     "Globally unique ID for this repository as an collection of refs for redistribution to other repositories", "COLLECTION-ID" },